home *** CD-ROM | disk | FTP | other *** search
/ PC-SIG: World of Games / PC-SIG World of Games (CDRM1080710) (1993).iso / ENT / DISK3160.ZIP / AQUATSR.ZIP / AQUATSR.DOC < prev    next >
Text File  |  1992-07-03  |  18KB  |  363 lines
  1.                          AquaTSR (c)  1992
  2.                                                    by Ron, Chris and Kim Gray
  3.  
  4.  
  5. ------------------------------------------------------------------------------
  6. Reading the AQUATSR.DOC file with VIEW program:
  7.  
  8.   o  Use the UP/DOWN,  PG UP/PG DOWN,  HOME/END, LEFT/RIGHT keys to navigate
  9.      thru the document.
  10.  
  11.   o  Use the ESC key to exit out of VIEW back to DOS.
  12.  
  13.   o  VIEW.COM can be used to read any text document file.
  14.  
  15.   o  SYNTAX:   VIEW [drive][path] textfile.doc
  16.               Where textfile.doc is any text based file to view.
  17.               Where path is optional if VIEW.COM resides in the same directory
  18.                     the textfile exists.  To read a text file that is not in
  19.                     the same directory that VIEW.COM program is, just simply
  20.                     include the entire path.
  21.               Where drive is the location of the textfile. If the textfile.doc
  22.                     is on the current drive then the drive is not needed.
  23.  
  24.                     ex:  VIEW A:\AQUATSR.DOC
  25.  
  26.                     The textfile AQUATSR.DOC is on the floppy in drive A:
  27.                     in the root directory.
  28.  
  29.  
  30. ------------------------------------------------------------------------------
  31.                              AquaTSR(c) 1992
  32. Description:
  33.     Is an "automatic" screen saving program.  You specify the period of
  34.     inactivity that AquaTSR(c) will wait prior to starting up.  AquaTSR
  35.     features many of the fish swimming in the AQUARIUM(c) program such
  36.     as Seahorse, Divers Bell, Oscar, Angel and more.  Not compatible with
  37.     WINDOWS.  The AquaTSR Control Panel (AQUACP.EXE) lets you select fish,
  38.     create messages, unload and load AquaTSR etc.  Further,  you can load
  39.     or unload AquaTSR from a batch file.
  40.  
  41.     Registration is $15.95.
  42.  
  43. AquaTSR minimum requirements:
  44.      XT IBM compatible turbo (10mhz)
  45.      EGA color monitor with 256K video memory
  46.      DOS 3.x or greater
  47.      243k DOS memory, 4.6k when resident!
  48.      Hard Drive with 840k available- this includes space for program swap
  49.                                      and video file save when AquaTSR is
  50.                                      activated.
  51. Compatability:
  52.     In order to move large amounts of objects,  while in high resolution
  53.     EGA screen mode 640 x 350,  all the video routines were written in
  54.     assembly code.  Further,  direct writes to the video registers had
  55.     to be performed.
  56.     AquaTSR has been tested on NCR, ZENITH, MIT, GATEWAY, PACKARD BELL,
  57.     EVEREX, COMPAC, TECH486 and MAX machines succesfully.
  58.  
  59. Incompatability:
  60.     AquaTSR is strictly a DOS program and is not compatible with WINDOWS
  61.     environment.  Use a batch file to unload AquaTSR prior to starting
  62.     WIN.
  63.  
  64. ______________________________________________________________________________
  65.  
  66.                    INSTALLING AquaTSR ON YOUR HARD DISC
  67. Note: If you already own the AQUARIUM(c) program, both the AquaTSR files and
  68.       AQUARIUM files can co-exist in the same directory.  It is not necessary
  69.       to create a seperate directory for AquaTSRs files.
  70.  
  71.     o    Insert the AquaTSR diskette in drive A: and close the door.
  72.          Next, log onto drive A: by typing              A: (press ENTER key)
  73.  
  74.     o    Start the installation by typing       INSTALL C: (press ENTER key)
  75.  
  76.                    Syntax:   INSTALL Drive:
  77.  
  78.         Where 'Drive:' is the drive letter of the hard disk drive where you
  79.         wish to install this program.
  80.         Such as   C:  or  D:  ect.
  81.  
  82.     o   Here is a list of the file names and brief description.
  83.  
  84.                     AQUATSR.EXE     Main TSR program
  85.                     AQUATSR.001     Graphics Picture File
  86.                     AQUATSR.002     Graphics Picture File
  87.                     AQUATSR.DOC     This Document
  88.                     AQUATSR.CFG     Last AquaTSR configuration saved here
  89.                     INSTALL.BAT     Batch file that will automatically install
  90.                                     the AquaTSR files on your hard drive.
  91.                     AQUACP .EXE     AquaTSR Control Panel used to select the
  92.                                     fish,  period of inactivity,  create
  93.                                     floating messages, and load or unload
  94.                                     AquaTSR program (optional).
  95.                     VIEW   .COM     Program to view the AQUATSR.DOC text file.
  96.                     -----------     ------------------------------------------
  97.               *     TSRSWAP.000     Files created by AquaTSR when swapping
  98.               *     TSRSWAP.001     program memory out during pop up time.
  99.               **    SCRSAV2.TSR     File created by AquaTSR when saving the
  100.                                     video screen that AquaTSR popped up over.
  101.                     AQGO   .BAT     Batch file created by AQUACP.EXE program
  102.                                     when the LOAD or UNLOAD buttons are
  103.                                     selected.  This file is deleted when
  104.                                     AQUACP.EXE program is exited.
  105.  
  106. *  These files will be created at start up time by AquaTSR.
  107. ** This file is created when AquaTSR pops up.
  108.  
  109. ______________________________________________________________________________
  110.  
  111.                             LOADING AquaTSR
  112.  
  113. method 1:
  114. Loading AquaTSR from the AquaTSR Control Panel program AQUACP.EXE
  115.  o   Log on to your hard drive by typing       C:            (press ENTER key)
  116.  o   Change to the AQUARIUM directory          CD \AQUARIUM  (press ENTER key)
  117.  o   Start up AquaCP program                   AQUACP        (press ENTER key)
  118.  
  119. While in the AquaCP program press the button "LOAD TSR"  which will batch file
  120. out to start up the AquaTSR program and return to AQUACP screen.
  121.  
  122.  
  123. method 2:
  124. Loading AquaTSR directly from DOS prompt:
  125.  o   Log on to your hard drive by typing       C:            (press ENTER key)
  126.  o   Change to the AQUARIUM directory          CD \AQUARIUM  (press ENTER key)
  127.  o   Start up AquaTSR program                  AQUATSR       (press ENTER key)
  128.  
  129. You will now see the line-
  130.         "AquaTSR will pop up after xx minutes of keyboard inactivity"
  131.  
  132.  
  133. If you forgot that AquaTSR was already in memory and you tried to load a
  134. second copy, AquaTSR will return the message-
  135.         "AquaTSR will pop up after xx minutes of keyboard inactivity"
  136.         "Aqua-TSR already loaded"
  137.  
  138. ______________________________________________________________________________
  139.  
  140.                         POPPING AquaTSR DOWN
  141.  
  142.  Once AquaTSR starts up the aquarium activity,  a touch of your keyboard key
  143.  will cause AquaTSR to restore your video screen, swap back into CPU memory
  144.  approximately 172K bytes of program code, and pop back down.  The program
  145.  or DOS that AquaTSR popped up over can now resume.
  146.  AquaTSR does not monitor the mouse during animation, so mouse clicks or
  147.  movement will not effect AquaTSR.
  148.  
  149.  o   ESC key pressed after AquaTSR pops up will cause AquaTSR to unload from
  150.      memory.   If AquaTSR has popped up over another program,  AquaTSR will
  151.      sense this and display a message that it is unable to unload at this
  152.      time.
  153.  
  154.  o   All keys except ESC key will cause AquaTSR to pop back down.
  155.  
  156. ______________________________________________________________________________
  157.  
  158.                         UNLOADING AquaTSR
  159. method 1:
  160. Unloading AquaTSR from the AquaTSR Control Panel program AQUACP.EXE
  161.  o   Log on to your hard drive by typing       C:            (press ENTER key)
  162.  o   Change to the AQUARIUM directory          CD \AQUARIUM  (press ENTER key)
  163.  o   Start up AquaCP program                   AQUACP        (press ENTER key)
  164.  
  165. While in the AquaCP program press the button "UNLOAD TSR"  which will batch
  166. file out to remove the AquaTSR program and return to AQUACP screen.
  167.  
  168.  
  169. method 2:
  170. Unloading AquaTSR directly from DOS prompt:
  171.  o   Log on to your hard drive by typing    C:               (press ENTER key)
  172.  o   Change to the AQUARIUM directory       CD \AQUARIUM     (press ENTER key)
  173.  o   Unload AquaTSR program                 REMOVTSR AQUATSR.EXE (press ENTER)
  174.  
  175. If AquaTSR was not loaded prior to trying to remove it you will see the
  176. message-
  177.        "AquaTSR not in memory or was not the last program loaded"
  178.  
  179.  
  180. ______________________________________________________________________________
  181.  
  182.                    STARTING AquaTSR FROM A BATCH FILE
  183.  
  184. To run AquaTSR from a batch file include these three lines:
  185.                        C:
  186.                        CD \AQUARIUM
  187.                        AQUATSR
  188.  
  189. Note:
  190. Refer to DOs & DONT rules if you are loading more than AquaTSR in your batch.
  191.  
  192.         CD = DOS command to Change Directory.  This is very important because
  193.              AquaTSR will then use the current directory to locate the config
  194.              file and where to put new files for swaping out program and video
  195.              memory.  If a different directory other than \AQUARIUM was used
  196.              then replace with the appropriate name.
  197.         C: = drive (replace with d:  if using D drive etc.) May be omitted if
  198.              the current drive is to be used.
  199.    AQUATSR = The TSR program
  200.  
  201. ______________________________________________________________________________
  202.  
  203.                      AquaTSR PROGRAM OPERATION
  204.  
  205. The phrase "Terminate and Stay Resident", or "TSR", comes from the DOS
  206. service that provides the ability for a program to become memory-resident.
  207. As the name implies, a TSR is a program that is loaded and takes up
  208. residence in memory,  waiting to perform its task.  This task may require the
  209. TSR to pop-up over another program or DOS.  When the TSR pops up or becomes
  210. active, it suspends any foreground process (program) while performing its task
  211. such as screen saving.
  212. TSR activation or pop-up always occur during the servicing of an interrupt.
  213. AquaTSR when resident in memory,  hooks the clock interrupt such that AquaTSR
  214. code is called 18.2 times a second.  AquaTSR keeps track of this to time the
  215. duration period of keyboard or mouse (if present) inactivity.  The keyboard
  216. interrupt is also hooked such that each time a key is pressed,  AquaTSR will
  217. examine it to see if the AquaTSRs' hot keys  (ALT key and '.' period key)
  218. were pressed and also to reset the inactivity timer count to zero.
  219. When the inactivity counter reaches the period (1 - 30 min) selected by you,
  220. AquaTSR will then pop up, saving program memory and video screen prior to
  221. starting up your aquarium.  When AquaTSR is resident in memory only a small
  222. kernel of approximately 4.6k remains resident in memory to monitor the
  223. interrupt process.  Upon popping up,  AquaTSR will swap out 172K of DOS memory
  224. to the file TSRSWAP.000 and swap in AquaTSR program from TSRSWAP.001 file.
  225. During this process a blinking green box will appear in the upper left corner
  226. of your video screen if you are in TEXT mode.  Depending on your machine speed
  227. will take a second or two.  If during animation you reset or boot your machine,
  228. the TSRSWAP.00x files will be present.  Normally when AquaTSR is removed from
  229. memory these files are deleted.  An additional file called SCRSAV2.TSR will be
  230. created to save the current video memory image.
  231.  
  232.  
  233. ______________________________________________________________________________
  234.  
  235.                     TSR RULES - DOs AND DONTs
  236.  
  237. DO unload TSR programs on a last in first out.   If you wish to later remove
  238.    AquaTSR from memory,  you must ensure that AquaTSR was the last TSR loaded.
  239.    Remember, the last TSR loaded would be the first to unload.
  240.  
  241. DONT try to unload AquaTSR, if you installed other TSR programs after AquaTSR.
  242.    However,  during AquaTSR animation you may unload it by pressing the ESC
  243.    key.  If AquaTSR detected it was popped up over another program,  the
  244.    display "UNABLE TO TERMINATE AT THIS TIME, TRY LATER." will appear, simply
  245.    press a different key once to resume animation,  and a second time to pop
  246.    down AquaTSR.  In this case you must first quit the current program that
  247.    AquaTSR popped up over prior to using the ESC key to unload AquaTSR from
  248.    memory.
  249.  
  250.              
  251. ______________________________________________________________________________
  252.  
  253.                        POSSIBLE PROBLEMS  Q & A
  254. o  While in the AquaTSR Control Panel program,  upon selecting either the LOAD
  255.    or UNLOAD TSR buttons the Control Panel program terminated and I was
  256.    was returned back to my DOS SHELL or MENU program.  Why?
  257.    The AQUACP program creates a batch file called AQGO.BAT to allows AQUACP to
  258.    quit momentarily,  start up AquaTSR program and return to AQUACP program.  If you used a shell or batch program to origionally start up the
  259.    AQUACP.EXE program actually terminates prior to running the AQGO.BAT file,
  260.    DOS assumes that it finished, in which control now passes back to the
  261.    origional menu or DOS shell that started up AQUACP.EXE program.
  262.    If you are using a menu that calls other programs thru batch files, then
  263.    you must create two batch files for loading or unloading AquaTSR the same
  264.    way that AQUACP would do it.
  265.  
  266.           example:   UNLOAD.BAT         (file)
  267.                      CD \AQUARIUM       (changes directory to AquaTSR location)
  268.                      REMOVTSR AQUATSR.EXE  (removes AquaTSR from memory)
  269.  
  270.           example:   LOAD.BAT           (file)
  271.                      CD \AQUARIUM       (changes directory to AquaTSR location)
  272.                      AQUATSR            (installs AquaTSR into memory)
  273.  
  274. o  When AquaTSRs hot keys (ALT and '.'period) are pressed, why does AquaTSR
  275.    sometimes fail to pop up?   AquaTSR monitors the DOS busy flag to make sure
  276.    that something important is not in progress.  If the DOS busy flag is set
  277.    AquaTSR waits a short time to see if the busy flag goes away.
  278.    If not then AquaTSR goes back to sleep.  A second attempt to pop up AquaTSR
  279.    will then be needed.
  280.    Further, if AquaTSR refuses to pop up over a currently running program, it
  281.    is because the keyboard interrupt is being interrigated before AquaTSR has
  282.    a chance to.  In this case you must first terminate (quit) the current
  283.    program and then you should be able to POP up AquaTSR.
  284.  
  285. o  While working in GEM DRAW with the mouse,  AquaTSR pops up anyway.  Why
  286.    didn't AquaTSR know that the mouse was being used?
  287.    Because many CAD programs almost exclusively use the mouse,  it is not
  288.    enough to only watch the keyboard for inactivity.  AquaTSR watches both
  289.    mouse and keyboard for inactivity,  however some programs ignore the mouse
  290.    software already present in memory and uses their own mouse routines.
  291.    When this happens AquaTSR can no longer monitor mouse activity.
  292.    You have two choices here, 1- Unload AquaTSR prior to starting a graphic
  293.    program that uses its own mouse code.  2 - Set the inactivity period to at
  294.    least 20- 30 minutes.  This way if AquaTSR rudely visits you while you are
  295.    using the mouse, touch a key to pop AquaTSR back down for another 20-30
  296.    minutes and continue with your drawing.
  297.    AquaTSR works fine with many other CAD programs such as SCHEMA or AutoCAD.
  298.    
  299. o  My graphic animation program screen was not restored properly when AquaTSR
  300.    popped back down,  Why?
  301.    Most programs do not perform continuous screen updating, but simply wait
  302.    for a key or mouse input in order to carry out tasks.   Other programs
  303.    involving "animation",  will perform many thousands of video changes each
  304.    second.   These programs are "video intensive", meaning most of the time
  305.    they continually perform some task with the video registers or video memory
  306.    (images).  The chances are very high that when AquaTSR pops up over these
  307.    video intensive programs,  it will interrupt setup calls to the video
  308.    registers (ie:map, mask, overscan, pan and pel etc).  The results may not
  309.    be predictable.  Further,  the EGA palette registers that allow a program
  310.    to map 1 of 16 colors to 1 of 64 are "write only" and can not be read so
  311.    that they are restored properly.  Given this, the results of popping
  312.    AquaTSR over such a program could be loss of origional screen images or
  313.    color,  you have only one choice here, DONT.
  314.  
  315. ______________________________________________________________________________
  316.  
  317.                   AquaTSR POSSIBLE ERROR CODES
  318.  
  319.     1  =  DOS Services are not available.  AquaTSR should attempt to pop back
  320.           down when this is encountered.  You should not see this one.
  321.     2  =  Not enough memory to become resident.  AquaTSR will report the
  322.           amount of memory detected in this case.  If applicable you should
  323.           off-load other TSR programs to free up memory.
  324.     3  =  Unable to become memory resident.
  325.     4  =  System is running under DOS 2.x, so AquaTSR cannot become resident.
  326.    10  =  Error initializing disk swapping files.  This may occur if there is
  327.           insufficient room on your hard disk to create the files TSRSWAP.000
  328.           and TSRSWAP.001 when AquaTSR popped up.
  329.  
  330.                        DOS CRITICAL ERROR CODES
  331.     7  =  Out of memory.  Not enough memory to load AquaTSR to begin with.
  332. ______________________________________________________________________________
  333.  
  334.                  AQUARIUM(c) 1991, 1992 - fish tank
  335.  
  336. AQUARIUM(c) turns your monitor into a eye-catching fish tank.
  337. Aquariums are a proven method of relaxing.   This realistic aquarium lets
  338. you control the number and type of fish, display floating messages in the
  339. background, make the fish change direction,  and more.
  340. AQUARIUM features all objects shown in the AquaTSR Control Panel program
  341. AQUACP,  plus a bubbler that starts up when viewing your AQUARIUM.
  342.  
  343. AQUARIUM minimum requirements:
  344.  
  345.     DOS 2.1 or higher
  346.     XT turbo machine (10mhz)
  347.     292K cpu memory
  348.     EGA or VGA color monitor, with 256K video memory
  349.     Single 360K floppy drive
  350.  
  351.     Mouse is OPTIONAL
  352.  
  353. Registration is only $14.95.
  354.  
  355. Registered programs include the FILE feature,  which allows you to save
  356. up to 10 different AQUARIUM configurations.
  357. Ask your local BBS or Shareware Distributor for a demo copy.
  358.  
  359.  
  360. Regards
  361. Ron Gray
  362.  
  363.